Predefined variables

The possible predefined variables values are the following:

Variable name

Description

CoverMessage

Cover page text.

CoverTemplate

Cover page file.

CSID

CSID to send to the remote fax system when transmitting the message.

DeferredShift

Shift used for fax transmission. Enter 1 for shift 1, 2 for shift 2, 3 for shift 3 or anything else for default. In Faxgate Administrator , shifts are set in the Preprocessor properties.

DestIdent

Recipient identifier.

DocumentHandler

Document Handler module identifier.

FaxNumber

Recipient fax number (primary destination). Address type variable.

FaxNumberAlternate

Recipient alternate fax number (alternate destination). Used if the primary destination (FaxNumber) is unavailable. Address type variable.

FormBackground

Template designer parameter. Name of the background bitmap to use for the merge.

FormSignature

Template designer parameter. Signature bitmap to insert in the form.

FormTemplate

Template designer parameter. Name of the template indicating where the text will be inserted on the form.

FromAccount

Sender account (as it will appear on cover page).

FromCompany

Sender company (as it will appear on cover page).

FromCountry

Sender country (as it will appear on cover page).

FromDept

Sender department (as it will appear on cover page).

FromE-mail

Sender E-mail (as it will appear on cover page).

FromFax

Sender fax number (as it will appear on cover page).

FromMail

Sender mail address (as it will appear on cover page).

FromName

Sender name (as it will appear on cover page).

FromPost

Sender zip code (as it will appear on cover page).

FromSub

Sender sub-address (as it will appear on cover page).

FromUser1, FromUser2, FromUser3

Sender additional description (as it will appear on cover page).

FromVoice

Sender telephone number (as it will appear on cover page).

Header

Header to be used per page/document.

Identifier

Client application ID for the fax. Used by some Faxgate modules to uniquely identify it.

Landscape

Orientation used to send the fax. Enter 0 for portrait (default value) or 1 for landscape.

MaxRetry

Maximum number of retries for a particular fax job.

Notify

Notify mode: E (notify every send attempt), S (notify on successful send), F (notify on final failure), A (notify on successful send or final failure).

NotifyAddress

Notification address in case of fax send failure. The address syntax depends on the NotifyAddressType.

NotifyAddressType

Notification address type in case of fax send failure. The possible values are: LN (Lotus Notes), GW (Groupwise), CC (cc:Mail), MS (MS Mail), SM (SMTP), PR (Printer), FX (Fax machine), AL (16-bit client), AC (LanFax client), LB (Load balanced Fax), AF (ASCII comma delimited file and TIFF file), EX or CN (Exchange), SAP (SAP).

Printer

Printer network path. For example: \\pcprint\myprinter .

PrinterIdent

Printer identifier.

Priority

Message priority. Valid priority codes are: R (Regular ; a blank is equivalent to R), U (Urgent), I (Immediate), L (Low).

RecipientAddress

Recipient address. The address syntax depends on the RecipientType. Address type variable.

RecipientAddressIdent

Recipient address identifier.

RecipientType

Recipient address type. The possible values are: LN (Lotus Notes), GW (Groupwise), CC (cc:Mail), MS (MS Mail), SM (SMTP), PR (Printer), FX (Fax machine), AL (16-bit client), AC (LanFax client), LB (Load balanced Fax), AF (ASCII comma delimited file and TIFF file), EX or CN (Exchange), SAP (SAP).

Subject

Message subject.

ToAccount

Recipient account (as it will appear on cover page).

ToCompany

Recipient company (as it will appear on cover page).

ToCountry

Recipient country (as it will appear on cover page).

ToDept

Recipient department (as it will appear on cover page).

ToE-mail

Recipient E-mail (as it will appear on cover page).

ToMail

Recipient mail address (as it will appear on cover page).

ToName

Recipient name (as it will appear on cover page).

ToPostal

Recipient zip code (as it will appear on cover page).

ToUser1, ToUser2, ToUser3

Recipient additional description (as it will appear on cover page).

ToVoice

Recipient telephone number.

Variable name	Description
CoverMessage	Cover page text.
CoverTemplate	Cover page file.
CSID	CSID to send to the remote fax system when transmitting the message.
DeferredShift	Shift used for fax transmission. Enter 1 for shift 1, 2 for shift 2, 3 for shift 3 or anything else for default. In Faxgate Administrator , shifts are set in the Preprocessor properties.
DestIdent	Recipient identifier.
DocumentHandler	Document Handler module identifier.
FaxNumber	Recipient fax number (primary destination). Address type variable.
FaxNumberAlternate	Recipient alternate fax number (alternate destination). Used if the primary destination (FaxNumber) is unavailable. Address type variable.
FormBackground	Template designer parameter. Name of the background bitmap to use for the merge.
FormSignature	Template designer parameter. Signature bitmap to insert in the form.
FormTemplate	Template designer parameter. Name of the template indicating where the text will be inserted on the form.
FromAccount	Sender account (as it will appear on cover page).
FromCompany	Sender company (as it will appear on cover page).
FromCountry	Sender country (as it will appear on cover page).
FromDept	Sender department (as it will appear on cover page).
FromE-mail	Sender E-mail (as it will appear on cover page).
FromFax	Sender fax number (as it will appear on cover page).
FromMail	Sender mail address (as it will appear on cover page).
FromName	Sender name (as it will appear on cover page).
FromPost	Sender zip code (as it will appear on cover page).
FromSub	Sender sub-address (as it will appear on cover page).
FromUser1, FromUser2, FromUser3	Sender additional description (as it will appear on cover page).
FromVoice	Sender telephone number (as it will appear on cover page).
Header	Header to be used per page/document.
Identifier	Client application ID for the fax. Used by some Faxgate modules to uniquely identify it.
Landscape	Orientation used to send the fax. Enter 0 for portrait (default value) or 1 for landscape.
MaxRetry	Maximum number of retries for a particular fax job.
Notify	Notify mode: E (notify every send attempt), S (notify on successful send), F (notify on final failure), A (notify on successful send or final failure).
NotifyAddress	Notification address in case of fax send failure. The address syntax depends on the NotifyAddressType.
NotifyAddressType	Notification address type in case of fax send failure. The possible values are: LN (Lotus Notes), GW (Groupwise), CC (cc:Mail), MS (MS Mail), SM (SMTP), PR (Printer), FX (Fax machine), AL (16-bit client), AC (LanFax client), LB (Load balanced Fax), AF (ASCII comma delimited file and TIFF file), EX or CN (Exchange), SAP (SAP).
Printer	Printer network path. For example: \\pcprint\myprinter .
PrinterIdent	Printer identifier.
Priority	Message priority. Valid priority codes are: R (Regular ; a blank is equivalent to R), U (Urgent), I (Immediate), L (Low).
RecipientAddress	Recipient address. The address syntax depends on the RecipientType. Address type variable.
RecipientAddressIdent	Recipient address identifier.
RecipientType	Recipient address type. The possible values are: LN (Lotus Notes), GW (Groupwise), CC (cc:Mail), MS (MS Mail), SM (SMTP), PR (Printer), FX (Fax machine), AL (16-bit client), AC (LanFax client), LB (Load balanced Fax), AF (ASCII comma delimited file and TIFF file), EX or CN (Exchange), SAP (SAP).
Subject	Message subject.
ToAccount	Recipient account (as it will appear on cover page).
ToCompany	Recipient company (as it will appear on cover page).
ToCountry	Recipient country (as it will appear on cover page).
ToDept	Recipient department (as it will appear on cover page).
ToE-mail	Recipient E-mail (as it will appear on cover page).
ToMail	Recipient mail address (as it will appear on cover page).
ToName	Recipient name (as it will appear on cover page).
ToPostal	Recipient zip code (as it will appear on cover page).
ToUser1, ToUser2, ToUser3	Recipient additional description (as it will appear on cover page).
ToVoice	Recipient telephone number.